<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class CPSOAuthBehavior</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class CPSOAuthBehavior</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-consts">Constants</a>
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">CPSOAuthBehavior provides OAuth support to any Pogostick component</p>
	<ul class="tags">
				<li><span class="field">author:</span> Jerry Ablan &lt;<a href="mailto:jablan@pogostick.com">jablan@pogostick.com</a>&gt;</li>
				<li><span class="field">version:</span> SVN: $Id: CPSOAuthBehavior.php 233 2009-06-10 23:54:16Z jerryablan@gmail.com $</li>
				<li><span class="field">since:</span> 1.0.0</li>
				<li><span class="field">uses:</span> pogostick.components.oauth.OAuth.php</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_pogostick---behaviors---CPSOAuthBehavior.php.html">/pogostick/behaviors/CPSOAuthBehavior.php</a> (line <span class="field">21</span>)
		</p>
		
				
		<pre>CBehavior
   |
   --<a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html">CPSComponentBehavior</a>
      |
      --<a href="../../psYiiExtensions/Behaviors/CPSApiBehavior.html">CPSApiBehavior</a>
         |
         --CPSOAuthBehavior</pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
															<a href="#sec-consts">Constants</a>
							
					</div>
		<div class="info-box-body">
			<div class="var-summary">
																																<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$m_arCurToken" title="details" class="var-name">$m_arCurToken</a>
				</div>
																<div class="var-title">
					<span class="var-type">OAuth</span>
					<a href="#$m_oOAuth" title="details" class="var-name">$m_oOAuth</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-consts">Constants</a>
							
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																												
												<div class="method-definition">
											<span class="method-result">CPSOAuthBehavior</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getAuthorizeUrl" title="details" class="method-name">getAuthorizeUrl</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$oToken</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">oauth</span>
										<a href="#getOAuthObject" title="details" class="method-name">getOAuthObject</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#getToken" title="details" class="method-name">getToken</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#init" title="details" class="method-name">init</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#loadToken" title="details" class="method-name">loadToken</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#storeToken" title="details" class="method-name">storeToken</a>
											([<span class="var-type">array</span>&nbsp;<span class="var-name">$oToken</span> = <span class="var-default">array()</span>])
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-consts">Constants</a>
							
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$m_arCurToken" id="$m_arCurToken"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$m_arCurToken</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">38</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The current token</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$m_oOAuth" id="$m_oOAuth"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">OAuth</span>
			<span class="var-name">$m_oOAuth</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">32</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">*  Our OAuth object</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
							<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html">CPSComponentBehavior</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#var$m_sInternalName">CPSComponentBehavior::$m_sInternalName</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#var$m_sPrefixDelimiter">CPSComponentBehavior::$m_sPrefixDelimiter</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																			<a href="#sec-consts">Constants</a>
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">63</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">*</p>
<p class="description"><p>Constructor</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">CPSOAuthBehavior</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../psYiiExtensions/Behaviors/CPSApiBehavior.html#method__construct">CPSApiBehavior::__construct()</a></dt>
						<dd>*</dd>
					</dl>
			
	</div>
<a name="methodgetAuthorizeUrl" id="getAuthorizeUrl"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getAuthorizeUrl</span> (line <span class="line-number">136</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">I  Appends the current token to the authorizeUrl option</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getAuthorizeUrl
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$oToken</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$oToken</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetOAuthObject" id="getOAuthObject"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getOAuthObject</span> (line <span class="line-number">53</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieves the OAuth object</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">oauth</span>
		<span class="method-name">
			getOAuthObject
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetToken" id="getToken"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getToken</span> (line <span class="line-number">48</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Retrieves the current token</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getToken
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodinit" id="init"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">init</span> (line <span class="line-number">106</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Initialize this behavior</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			init
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodloadToken" id="loadToken"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">loadToken</span> (line <span class="line-number">166</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loads a token from the user state oAuthToken</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			loadToken
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodstoreToken" id="storeToken"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">storeToken</span> (line <span class="line-number">147</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Stores the current token in a member variable and in the user state oAuthToken</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			storeToken
		</span>
					([<span class="var-type">array</span>&nbsp;<span class="var-name">$oToken</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$oToken</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../../psYiiExtensions/Behaviors/CPSApiBehavior.html">CPSApiBehavior</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSApiBehavior.html#method__construct">CPSApiBehavior::__construct()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSApiBehavior.html#methodaddRequestMapping">CPSApiBehavior::addRequestMapping()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSApiBehavior.html#methodmakeHttpRequest">CPSApiBehavior::makeHttpRequest()</a></span><br>
											</blockquote>
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html">CPSComponentBehavior</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#method__construct">CPSComponentBehavior::__construct()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodaddOption">CPSComponentBehavior::addOption()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodaddOptions">CPSComponentBehavior::addOptions()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodcheckCallbacks">CPSComponentBehavior::checkCallbacks()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodcheckOptions">CPSComponentBehavior::checkOptions()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodgetInternalName">CPSComponentBehavior::getInternalName()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodgetNamePrefix">CPSComponentBehavior::getNamePrefix()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodgetOption">CPSComponentBehavior::getOption()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodgetOptions">CPSComponentBehavior::getOptions()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodgetOptionsObject">CPSComponentBehavior::getOptionsObject()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodgetPrefixDelimiter">CPSComponentBehavior::getPrefixDelimiter()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodgetPublicOptions">CPSComponentBehavior::getPublicOptions()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodgetValidPattern">CPSComponentBehavior::getValidPattern()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodhasOption">CPSComponentBehavior::hasOption()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodisCBFunction">CPSComponentBehavior::isCBFunction()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodisEmpty">CPSComponentBehavior::isEmpty()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodmakeOptions">CPSComponentBehavior::makeOptions()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodmergeOptions">CPSComponentBehavior::mergeOptions()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodraiseEvent">CPSComponentBehavior::raiseEvent()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodsetInternalName">CPSComponentBehavior::setInternalName()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodsetOption">CPSComponentBehavior::setOption()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodsetOptions">CPSComponentBehavior::setOptions()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodsetPrefixDelimiter">CPSComponentBehavior::setPrefixDelimiter()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#methodsetValidPattern">CPSComponentBehavior::setValidPattern()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#method__get">CPSComponentBehavior::__get()</a></span><br>
													<span class="method-name"><a href="../../psYiiExtensions/Behaviors/CPSComponentBehavior.html#method__set">CPSComponentBehavior::__set()</a></span><br>
											</blockquote>
										
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Constants</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../psYiiExtensions/Behaviors/CPSApiBehavior.html">CPSApiBehavior</a></span></p>
					<blockquote>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../psYiiExtensions/Behaviors/CPSApiBehavior.html#constHTTP_GET">CPSApiBehavior::HTTP_GET</a></span><br>
							</span>
													<img src="../../media/images/Variable.png" />
							<span class="const-title">
								<span class="const-name"><a href="../../psYiiExtensions/Behaviors/CPSApiBehavior.html#constHTTP_POST">CPSApiBehavior::HTTP_POST</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Mon, 15 Jun 2009 22:58:23 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
	</p>
	</div></body>
</html>